GET/marketplace/{marketplace_id}/get_hazardous_materials_labels
This method returns hazardous materials label information for the specified eBay marketplace. The information includes IDs, descriptions, and URLs (as applicable) for the available signal words, statements, and pictograms. The returned statements are localized for the default language of the marketplace. If a marketplace does not support hazardous materials label information, no response payload is returned, but only a 204 No content status code.
This information is used by the seller to add hazardous materials label related information to their listings (see Specifying hazardous material related information).
Input
Resource URI
This method is supported in Sandbox environment. To access the endpoint, just replace the api.ebay.com root URI with api.sandbox.ebay.com
URI parameters
| Parameter | Type | Description |
|---|---|---|
| marketplace_id | string | This path parameter specifies the eBay marketplace for which hazardous materials label information shall be retrieved. See HTTP Request Headers for a list of supported eBay marketplace ID values. Occurrence: Required |
HTTP request headers
All requests made to eBay REST operations require you to provide the Authorization HTTP header for authentication authorization.
All other standard RESTful request headers are optional. For more information on standard RESTful request headers, see the HTTP request headers- opens rest request components page table.
OAuth scope
This request requires an access token created with the client credentials grant flow, using one or more scopes from the following list (please check your Application Keys page for a list of OAuth scopes available to your application):
https://api.ebay.com/oauth/api_scope
See OAuth access tokens for more information.
Request payload
This call has no payload.
Request fields
This call has no field definitions.
Output
HTTP response headers
This call has no response headers.
Response payload
Response fields
| Output container/field | Type | Description |
|---|---|---|
| signalWords | array of SignalWord | This array contains available hazardous materials signal words for the specified marketplace. Occurrence: Conditional |
| signalWords.signalWordId | string | The identifier of the signal word. For more information, see Signal word information. Occurrence: Conditional |
| signalWords.signalWordDescription | string | The description of the signal word localized to the default language of the marketplace. For more information, see Signal word information. Occurrence: Conditional |
| statements | array of HazardStatement | This array contains available hazardous materials hazard statements for the specified marketplace. Occurrence: Conditional |
| statements.statementId | string | The identifier of the statement. For sample values, see Hazard statement sample values. Occurrence: Conditional |
| statements.statementDescription | string | The description of the statement localized to the default language of the marketplace. For sample values, see Hazard statement sample values. Occurrence: Conditional |
| pictograms | array of Pictogram | This array contains available hazardous materials hazard pictograms for the specified marketplace. Occurrence: Conditional |
| pictograms.pictogramId | string | The identifier of the pictogram. For sample values, see Pictogram sample values. Occurrence: Conditional |
| pictograms.pictogramDescription | string | The description of the pictogram localized to the default language of the marketplace. For sample values, see Pictogram sample values. Occurrence: Conditional |
| pictograms.pictogramUrl | string | The URL of the pictogram. Occurrence: Conditional |
HTTP status codes
This call can return one of the following HTTP status codes. For an overview of the status codes, see HTTP status codes in Using eBay RESTful APIs.
| Status | Meaning |
|---|---|
| 200 | Success |
| 404 | Not found |
| 500 | Internal Server Error |
Error codes
For more on errors, plus the codes of other common errors, see Handling errors.
| Code | Domain | Category | Meaning |
|---|---|---|---|
| 46000 | API_METADATA | APPLICATION | There was a problem with an eBay internal system or process.Contact eBay developer support for assistance. |
| 46001 | API_METADATA | REQUEST | The specified marketplace ID was not found. |
Warnings
This call has no warnings.
Samples
New to making API calls? Please see Making a Call.
Note: Identifiers, such as order IDs or user IDs, and personal data in these samples might be anonymized or may no longer be active on eBay. If necessary, substitute current, relevant eBay data in your requests.
Sample 1: Get the available hazardous material labels information for a specified marketplace
This example retrieves the available hazardous material labels information for the EBAY_GB marketplace.
Input
The marketplace EBAY_GB is passed in as a path parameter. This method does not use a request payload.
GEThttps://api.ebay.com/sell/metadata/v1/marketplace/EBAY_GB/get_hazardous_materials_labels
Output
A successful call returns the details of the specified marketplace.